<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Encode::Encoding - Encode Implementation Base Class - Perldoc Browser</title>
    <link rel="search" href="https://perldoc.perl.org/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser">
    <link rel="canonical" href="https://perldoc.perl.org/Encode::Encoding">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" />
    <style>
      body {
        background: #f4f4f5;
        color: #020202;
      }
      .navbar-dark {
        background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%);
        filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0);
        background-repeat: repeat-x;
      }
      .navbar-dark .navbar-nav .nav-link,
      .navbar-dark .navbar-nav .nav-link:focus { color: #fff }
      .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 }
      #wrapperlicious {
        margin: 0 auto;
        font: 0.9em 'Helvetica Neue', Helvetica, sans-serif;
        font-weight: normal;
        line-height: 1.5em;
        margin: 0;
        padding: 0;
      }
      #wrapperlicious h1 { font-size: 1.5em }
      #wrapperlicious h2 { font-size: 1.3em }
      #wrapperlicious h3 { font-size: 1.1em }
      #wrapperlicious h4 { font-size: 0.9em }
      #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3,
      #wrapperlicious h4, #wrapperlicious dt {
        color: #020202;
        margin-top: 1em;
        margin-bottom: 1em;
        position: relative;
        font-weight: bold;
      }
      #wrapperlicious a { color: inherit; text-decoration: underline }
      #wrapperlicious #toc { text-decoration: none }
      #wrapperlicious a:hover { color: #2a2a2a }
      #wrapperlicious a img { border: 0 }
      #wrapperlicious :not(pre) > code {
        color: inherit;
        background-color: rgba(0, 0, 0, 0.04);
        border-radius: 3px;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        padding: 0.3em;
      }
      #wrapperlicious dd {
        margin: 0;
        margin-left: 2em;
      }
      #wrapperlicious dt {
        color: #2a2a2a;
        font-weight: bold;
        margin-left: 0.9em;
      }
      #wrapperlicious p {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious li > p {
        margin-bottom: 0;
        margin-top: 0;
      }
      #wrapperlicious pre {
        border: 1px solid #c1c1c1;
        border-radius: 3px;
        font: 100% Consolas, Menlo, Monaco, monospace;
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious pre > code {
        display: block;
        background-color: #f6f6f6;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        line-height: 1.5em;
        text-align: left;
        white-space: pre;
        padding: 1em;
      }
      #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious ul {
        list-style-type: square;
      }
      #wrapperlicious ul ul {
        margin-bottom: 0px;
        margin-top: 0px;
      }
      #footer {
        font-size: 0.8em;
        padding-top: 0.5em;
        text-align: center;
      }
      #more {
        display: inline;
        font-size: 0.8em;
      }
      #perldocdiv {
        background-color: #fff;
        border: 1px solid #c1c1c1;
        border-bottom-left-radius: 5px;
        border-bottom-right-radius: 5px;
        margin-left: auto;
        margin-right: auto;
        padding: 3em;
        padding-top: 1em;
        max-width: 960px;
      }
      #moduleversion { float: right }
      #wrapperlicious .leading-notice {
        font-style: italic;
        padding-left: 1em;
        margin-top: 1em;
        margin-bottom: 1em;
      }
      #wrapperlicious .permalink {
        display: none;
        left: -0.75em;
        position: absolute;
        padding-right: 0.25em;
        text-decoration: none;
      }
      #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink,
      #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink,
      #wrapperlicious dt:hover .permalink {
        display: block;
      }
    </style>
    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-KVNWBNT5FB');
      gtag('config', 'UA-50555-3');
    </script>
  </head>
  <body>
    <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between">
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <a class="navbar-brand" href="https://perldoc.perl.org/">Perldoc Browser</a>
  <div class="collapse navbar-collapse" id="navbarNav">
    <ul class="navbar-nav mr-auto">
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Encode::Encoding.html#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.35.0</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-stable">
          <a class="dropdown-item" href="https://perldoc.perl.org/Encode::Encoding">Latest</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.2/Encode::Encoding">5.38.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.1/Encode::Encoding">5.38.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0/Encode::Encoding">5.38.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.3/Encode::Encoding">5.36.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.2/Encode::Encoding">5.36.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.1/Encode::Encoding">5.36.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.0/Encode::Encoding">5.36.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.3/Encode::Encoding">5.34.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.2/Encode::Encoding">5.34.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.1/Encode::Encoding">5.34.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.0/Encode::Encoding">5.34.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.1/Encode::Encoding">5.32.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.0/Encode::Encoding">5.32.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.3/Encode::Encoding">5.30.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.2/Encode::Encoding">5.30.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.1/Encode::Encoding">5.30.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.0/Encode::Encoding">5.30.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.3/Encode::Encoding">5.28.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.2/Encode::Encoding">5.28.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.1/Encode::Encoding">5.28.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.0/Encode::Encoding">5.28.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.3/Encode::Encoding">5.26.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.2/Encode::Encoding">5.26.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.1/Encode::Encoding">5.26.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.0/Encode::Encoding">5.26.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.4/Encode::Encoding">5.24.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.3/Encode::Encoding">5.24.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.2/Encode::Encoding">5.24.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.1/Encode::Encoding">5.24.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.0/Encode::Encoding">5.24.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.4/Encode::Encoding">5.22.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.3/Encode::Encoding">5.22.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.2/Encode::Encoding">5.22.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.1/Encode::Encoding">5.22.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.0/Encode::Encoding">5.22.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.3/Encode::Encoding">5.20.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.2/Encode::Encoding">5.20.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.1/Encode::Encoding">5.20.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.0/Encode::Encoding">5.20.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.4/Encode::Encoding">5.18.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.3/Encode::Encoding">5.18.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.2/Encode::Encoding">5.18.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.1/Encode::Encoding">5.18.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.0/Encode::Encoding">5.18.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.3/Encode::Encoding">5.16.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.2/Encode::Encoding">5.16.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.1/Encode::Encoding">5.16.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.0/Encode::Encoding">5.16.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.4/Encode::Encoding">5.14.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.3/Encode::Encoding">5.14.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.2/Encode::Encoding">5.14.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.1/Encode::Encoding">5.14.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.0/Encode::Encoding">5.14.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.5/Encode::Encoding">5.12.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.4/Encode::Encoding">5.12.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.3/Encode::Encoding">5.12.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.2/Encode::Encoding">5.12.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.1/Encode::Encoding">5.12.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.0/Encode::Encoding">5.12.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.1/Encode::Encoding">5.10.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.0/Encode::Encoding">5.10.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.9/Encode::Encoding">5.8.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.8/Encode::Encoding">5.8.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.7/Encode::Encoding">5.8.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.6/Encode::Encoding">5.8.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.5/Encode::Encoding">5.8.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.4/Encode::Encoding">5.8.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.3/Encode::Encoding">5.8.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.2/Encode::Encoding">5.8.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.1/Encode::Encoding">5.8.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.0/Encode::Encoding">5.8.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.2/Encode::Encoding">5.6.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.1/Encode::Encoding">5.6.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.0/Encode::Encoding">5.6.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_04/Encode::Encoding">5.005_04</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_03/Encode::Encoding">5.005_03</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_02/Encode::Encoding">5.005_02</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_01/Encode::Encoding">5.005_01</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005/Encode::Encoding">5.005</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Encode::Encoding.html#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-dev">
          <a class="dropdown-item" href="https://perldoc.perl.org/blead/Encode::Encoding">blead</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.6/Encode::Encoding">5.39.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.5/Encode::Encoding">5.39.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.4/Encode::Encoding">5.39.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.3/Encode::Encoding">5.39.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.2/Encode::Encoding">5.39.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.1/Encode::Encoding">5.39.1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC2/Encode::Encoding">5.38.0-RC2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC1/Encode::Encoding">5.38.0-RC1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.11/Encode::Encoding">5.37.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.10/Encode::Encoding">5.37.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.9/Encode::Encoding">5.37.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.8/Encode::Encoding">5.37.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.7/Encode::Encoding">5.37.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.6/Encode::Encoding">5.37.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.5/Encode::Encoding">5.37.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.4/Encode::Encoding">5.37.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.3/Encode::Encoding">5.37.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.2/Encode::Encoding">5.37.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.1/Encode::Encoding">5.37.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.0/Encode::Encoding">5.37.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.11/Encode::Encoding">5.35.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.10/Encode::Encoding">5.35.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.9/Encode::Encoding">5.35.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.8/Encode::Encoding">5.35.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.7/Encode::Encoding">5.35.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.6/Encode::Encoding">5.35.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.5/Encode::Encoding">5.35.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.4/Encode::Encoding">5.35.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.3/Encode::Encoding">5.35.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.2/Encode::Encoding">5.35.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.1/Encode::Encoding">5.35.1</a>
          <a class="dropdown-item active" href="./Encode::Encoding.html">5.35.0</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Encode::Encoding.html#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-nav">
          <a class="dropdown-item" href="perl.html">Perl</a>
          <a class="dropdown-item" href="perlintro.html">Intro</a>
          <a class="dropdown-item" href="perl.html#Tutorials">Tutorials</a>
          <a class="dropdown-item" href="perlfaq.html">FAQs</a>
          <a class="dropdown-item" href="perl.html#Reference-Manual">Reference</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlop.html">Operators</a>
          <a class="dropdown-item" href="functions.html">Functions</a>
          <a class="dropdown-item" href="variables.html">Variables</a>
          <a class="dropdown-item" href="modules.html">Modules</a>
          <a class="dropdown-item" href="perlutil.html">Utilities</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlcommunity.html">Community</a>
          <a class="dropdown-item" href="perlhist.html">History</a>
        </div>
      </li>
    </ul>
    <ul class="navbar-nav">
      <script>
        function set_expand (expand) {
          var perldocdiv = document.getElementById('perldocdiv');
          var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width');
          var expanded = (width == '' || width == 'none') ? true : false;
          if (expand === null) {
            expand = !expanded;
          }
          if ((expand && !expanded) || (!expand && expanded)) {
            perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px');
            var button_classlist = document.getElementById('content-expand-button').classList;
            if (expand) {
              button_classlist.add('btn-light');
              button_classlist.remove('btn-outline-light');
            } else {
              button_classlist.add('btn-outline-light');
              button_classlist.remove('btn-light');
            }
          }
          return expand;
        }
        function toggle_expand () {
          var expand = set_expand(null);
          document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC';
        }
        function read_expand () {
          return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 });
        }
        if (document.readyState === 'loading') {
          document.addEventListener('DOMContentLoaded', function () {
            if (read_expand()) {
              set_expand(true);
            }
          });
        } else if (read_expand()) {
          set_expand(true);
        }
      </script>
      <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-2" onclick="toggle_expand()">Expand</button>
    <ul>
    <form class="form-inline" method="get" action="https://perldoc.perl.org/5.35.0/search">
      <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search">
    </form>
  </div>
</nav>

    <div id="wrapperlicious" class="container-fluid">
      <div id="perldocdiv">
        <div id="links">
          <a href="./Encode::Encoding.html">Encode::Encoding</a>
          <div id="more">
            (<a href="./Encode::Encoding.txt">source</a>,
            <a href="https://metacpan.org/pod/Encode::Encoding">CPAN</a>)
          </div>
            <div id="moduleversion">version 2.08</div>
        </div>
        <div class="leading-notice">
          You are viewing the version of this documentation from Perl 5.35.0.
            This is a development version of Perl.
        </div>
        <h1><a id="toc">CONTENTS</a></h1>
                  <ul>
              <li>
                <a class="text-decoration-none" href="./Encode::Encoding.html#NAME">NAME</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Encode::Encoding.html#SYNOPSIS">SYNOPSIS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Encode::Encoding.html#DESCRIPTION">DESCRIPTION</a>
                            <ul>
              <li>
                <a class="text-decoration-none" href="./Encode::Encoding.html#Methods-you-should-implement">Methods you should implement</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Encode::Encoding.html#Other-methods-defined-in-Encode::Encodings">Other methods defined in Encode::Encodings</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Encode::Encoding.html#Example:-Encode::ROT13">Example: Encode::ROT13</a>
              </li>
          </ul>

              </li>
              <li>
                <a class="text-decoration-none" href="./Encode::Encoding.html#Why-the-heck-Encode-API-is-different?">Why the heck Encode API is different?</a>
                            <ul>
              <li>
                <a class="text-decoration-none" href="./Encode::Encoding.html#Compiled-Encodings">Compiled Encodings</a>
              </li>
          </ul>

              </li>
              <li>
                <a class="text-decoration-none" href="./Encode::Encoding.html#SEE-ALSO">SEE ALSO</a>
              </li>
          </ul>

      <h1 id="NAME"><a class="permalink" href="./Encode::Encoding.html#NAME">#</a>NAME</h1>

<p>Encode::Encoding - Encode Implementation Base Class</p>

<h1 id="SYNOPSIS"><a class="permalink" href="./Encode::Encoding.html#SYNOPSIS">#</a>SYNOPSIS</h1>

<pre><code>package Encode::MyEncoding;
use parent qw(Encode::Encoding);

__PACKAGE__-&gt;Define(qw(myCanonical myAlias));</code></pre>

<h1 id="DESCRIPTION"><a class="permalink" href="./Encode::Encoding.html#DESCRIPTION">#</a>DESCRIPTION</h1>

<p>As mentioned in <a href="Encode.html">Encode</a>, encodings are (in the current implementation at least) defined as objects. The mapping of encoding name to object is via the <code>%Encode::Encoding</code> hash. Though you can directly manipulate this hash, it is strongly encouraged to use this base class module and add encode() and decode() methods.</p>

<h2 id="Methods-you-should-implement"><a class="permalink" href="./Encode::Encoding.html#Methods-you-should-implement">#</a><a id="Methods"></a>Methods you should implement</h2>

<p>You are strongly encouraged to implement methods below, at least either encode() or decode().</p>

<dl>

<dt id="-&gt;encode($string-[,$check])"><a class="permalink" href="./Encode::Encoding.html#-%3Eencode($string-%5B,$check%5D)">#</a><a id="encode-string-check"></a>-&gt;encode($string [,$check])</dt>
<dd>

<p>MUST return the octet sequence representing <i>$string</i>.</p>

<ul>

<li><p>If <i>$check</i> is true, it SHOULD modify <i>$string</i> in place to remove the converted part (i.e. the whole string unless there is an error). If perlio_ok() is true, SHOULD becomes MUST.</p>

</li>
<li><p>If an error occurs, it SHOULD return the octet sequence for the fragment of string that has been converted and modify $string in-place to remove the converted part leaving it starting with the problem fragment. If perlio_ok() is true, SHOULD becomes MUST.</p>

</li>
<li><p>If <i>$check</i> is false then <code>encode</code> MUST make a &quot;best effort&quot; to convert the string - for example, by using a replacement character.</p>

</li>
</ul>

</dd>
<dt id="-&gt;decode($octets-[,$check])"><a class="permalink" href="./Encode::Encoding.html#-%3Edecode($octets-%5B,$check%5D)">#</a><a id="decode-octets-check"></a>-&gt;decode($octets [,$check])</dt>
<dd>

<p>MUST return the string that <i>$octets</i> represents.</p>

<ul>

<li><p>If <i>$check</i> is true, it SHOULD modify <i>$octets</i> in place to remove the converted part (i.e. the whole sequence unless there is an error). If perlio_ok() is true, SHOULD becomes MUST.</p>

</li>
<li><p>If an error occurs, it SHOULD return the fragment of string that has been converted and modify $octets in-place to remove the converted part leaving it starting with the problem fragment. If perlio_ok() is true, SHOULD becomes MUST.</p>

</li>
<li><p>If <i>$check</i> is false then <code>decode</code> should make a &quot;best effort&quot; to convert the string - for example by using Unicode&#39;s &quot;\x{FFFD}&quot; as a replacement character.</p>

</li>
</ul>

</dd>
</dl>

<p>If you want your encoding to work with <a href="encoding.html">encoding</a> pragma, you should also implement the method below.</p>

<dl>

<dt id="-&gt;cat_decode($destination,-$octets,-$offset,-$terminator-[,$check])"><a class="permalink" href="./Encode::Encoding.html#-%3Ecat_decode($destination,-$octets,-$offset,-$terminator-%5B,$check%5D)">#</a><a id="cat_decode-destination-octets-offset-terminator-check"></a>-&gt;cat_decode($destination, $octets, $offset, $terminator [,$check])</dt>
<dd>

<p>MUST decode <i>$octets</i> with <i>$offset</i> and concatenate it to <i>$destination</i>. Decoding will terminate when $terminator (a string) appears in output. <i>$offset</i> will be modified to the last $octets position at end of decode. Returns true if $terminator appears output, else returns false.</p>

</dd>
</dl>

<h2 id="Other-methods-defined-in-Encode::Encodings"><a class="permalink" href="./Encode::Encoding.html#Other-methods-defined-in-Encode::Encodings">#</a><a id="Other"></a>Other methods defined in Encode::Encodings</h2>

<p>You do not have to override methods shown below unless you have to.</p>

<dl>

<dt id="-&gt;name"><a class="permalink" href="./Encode::Encoding.html#-%3Ename">#</a><a id="name"></a>-&gt;name</dt>
<dd>

<p>Predefined As:</p>

<pre><code class="plaintext">sub name  { return shift-&gt;{&#39;Name&#39;} }</code></pre>

<p>MUST return the string representing the canonical name of the encoding.</p>

</dd>
<dt id="-&gt;mime_name"><a class="permalink" href="./Encode::Encoding.html#-%3Emime_name">#</a><a id="mime_name"></a>-&gt;mime_name</dt>
<dd>

<p>Predefined As:</p>

<pre><code>sub mime_name{
  return Encode::MIME::Name::get_mime_name(shift-&gt;name);
}</code></pre>

<p>MUST return the string representing the IANA charset name of the encoding.</p>

</dd>
<dt id="-&gt;renew"><a class="permalink" href="./Encode::Encoding.html#-%3Erenew">#</a><a id="renew"></a>-&gt;renew</dt>
<dd>

<p>Predefined As:</p>

<pre><code>sub renew {
  my $self = shift;
  my $clone = bless { %$self } =&gt; ref($self);
  $clone-&gt;{renewed}++;
  return $clone;
}</code></pre>

<p>This method reconstructs the encoding object if necessary. If you need to store the state during encoding, this is where you clone your object.</p>

<p>PerlIO ALWAYS calls this method to make sure it has its own private encoding object.</p>

</dd>
<dt id="-&gt;renewed"><a class="permalink" href="./Encode::Encoding.html#-%3Erenewed">#</a><a id="renewed"></a>-&gt;renewed</dt>
<dd>

<p>Predefined As:</p>

<pre><code>sub renewed { $_[0]-&gt;{renewed} || 0 }</code></pre>

<p>Tells whether the object is renewed (and how many times). Some modules emit <code>Use of uninitialized value in null operation</code> warning unless the value is numeric so return 0 for false.</p>

</dd>
<dt id="-&gt;perlio_ok()"><a class="permalink" href="./Encode::Encoding.html#-%3Eperlio_ok()">#</a><a id="perlio_ok"></a>-&gt;perlio_ok()</dt>
<dd>

<p>Predefined As:</p>

<pre><code>sub perlio_ok { 
  return eval { require PerlIO::encoding } ? 1 : 0;
}</code></pre>

<p>If your encoding does not support PerlIO for some reasons, just;</p>

<pre><code class="plaintext">sub perlio_ok { 0 }</code></pre>

</dd>
<dt id="-&gt;needs_lines()"><a class="permalink" href="./Encode::Encoding.html#-%3Eneeds_lines()">#</a><a id="needs_lines"></a>-&gt;needs_lines()</dt>
<dd>

<p>Predefined As:</p>

<pre><code>sub needs_lines { 0 };</code></pre>

<p>If your encoding can work with PerlIO but needs line buffering, you MUST define this method so it returns true. 7bit ISO-2022 encodings are one example that needs this. When this method is missing, false is assumed.</p>

</dd>
</dl>

<h2 id="Example:-Encode::ROT13"><a class="permalink" href="./Encode::Encoding.html#Example:-Encode::ROT13">#</a><a id="Example"></a>Example: Encode::ROT13</h2>

<pre><code>package Encode::ROT13;
use strict;
use parent qw(Encode::Encoding);

__PACKAGE__-&gt;Define(&#39;rot13&#39;);

sub encode($$;$){
    my ($obj, $str, $chk) = @_;
    $str =~ tr/A-Za-z/N-ZA-Mn-za-m/;
    $_[1] = &#39;&#39; if $chk; # this is what in-place edit means
    return $str;
}

# Jr pna or ynml yvxr guvf;
*decode = \&amp;encode;

1;</code></pre>

<h1 id="Why-the-heck-Encode-API-is-different?"><a class="permalink" href="./Encode::Encoding.html#Why-the-heck-Encode-API-is-different?">#</a><a id="Why"></a><a id="Why-the-heck-Encode-API-is-different"></a>Why the heck Encode API is different?</h1>

<p>It should be noted that the <i>$check</i> behaviour is different from the outer public API. The logic is that the &quot;unchecked&quot; case is useful when the encoding is part of a stream which may be reporting errors (e.g. STDERR). In such cases, it is desirable to get everything through somehow without causing additional errors which obscure the original one. Also, the encoding is best placed to know what the correct replacement character is, so if that is the desired behaviour then letting low level code do it is the most efficient.</p>

<p>By contrast, if <i>$check</i> is true, the scheme above allows the encoding to do as much as it can and tell the layer above how much that was. What is lacking at present is a mechanism to report what went wrong. The most likely interface will be an additional method call to the object, or perhaps (to avoid forcing per-stream objects on otherwise stateless encodings) an additional parameter.</p>

<p>It is also highly desirable that encoding classes inherit from <code>Encode::Encoding</code> as a base class. This allows that class to define additional behaviour for all encoding objects.</p>

<pre><code>package Encode::MyEncoding;
use parent qw(Encode::Encoding);

__PACKAGE__-&gt;Define(qw(myCanonical myAlias));</code></pre>

<p>to create an object with <code>bless {Name =&gt; ...}, $class</code>, and call define_encoding. They inherit their <code>name</code> method from <code>Encode::Encoding</code>.</p>

<h2 id="Compiled-Encodings"><a class="permalink" href="./Encode::Encoding.html#Compiled-Encodings">#</a><a id="Compiled"></a>Compiled Encodings</h2>

<p>For the sake of speed and efficiency, most of the encodings are now supported via a <i>compiled form</i>: XS modules generated from UCM files. Encode provides the enc2xs tool to achieve that. Please see <a href="enc2xs.html">enc2xs</a> for more details.</p>

<h1 id="SEE-ALSO"><a class="permalink" href="./Encode::Encoding.html#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1>

<p><a href="perlmod.html">perlmod</a>, <a href="enc2xs.html">enc2xs</a></p>


      </div>
      <div id="footer">
        <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p>

<p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p>


      </div>
    </div>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
    <script src="../highlight.pack.js"></script>
    <script>hljs.highlightAll();</script>
  </body>
</html>
